Creating a new Holiday Calendar Association

Request

This endpoint returns structured Holiday Calendar Association objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the holiday_calendar_associations top-level JSON key. Please see our Response Format section for more information.

Query

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

holiday (Holiday) - The Holiday associated with this HolidayCalendarAssociation.
holiday_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarAssociation.

Bodyapplication/jsonrequired

holiday_calendar_associationobject

{
  "holiday_calendar_association": {
    "holiday_id": 0,
    "holiday_calendar_id": 0
  }
}

Responses

Holiday Calendar Association has been created.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

holiday_calendar_associationsobject

holidaysobject

holiday_calendarsobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "holiday_calendar_associations": {
    "property1": {
      "holiday_calendar_id": "string",
      "holiday_calendar_name": "string",
      "holiday_id": "string",
      "holiday_name": "string"
    },
    "property2": {
      "holiday_calendar_id": "string",
      "holiday_calendar_name": "string",
      "holiday_id": "string",
      "holiday_name": "string"
    }
  },
  "holidays": {
    "property1": {
      "calendar_names_list": "string",
      "end_date": "2019-08-24",
      "holiday_calendar_association_ids": [
        "string"
      ],
      "name": "string",
      "paid": true,
      "start_date": "2019-08-24",
      "total_hours": 0
    },
    "property2": {
      "calendar_names_list": "string",
      "end_date": "2019-08-24",
      "holiday_calendar_association_ids": [
        "string"
      ],
      "name": "string",
      "paid": true,
      "start_date": "2019-08-24",
      "total_hours": 0
    }
  },
  "holiday_calendars": {
    "property1": {
      "default": true,
      "name": "string"
    },
    "property2": {
      "default": true,
      "name": "string"
    }
  }
}